/*
 * Copyright (c) 2001, Aslak Hellesøy, BEKK Consulting
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * - Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 *
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 *
 * - Neither the name of BEKK Consulting nor the names of its
 *   contributors may be used to endorse or promote products derived from
 *   this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 */
package middlegen.plugins.ibatis;

import middlegen.Column;
import middlegen.DbNameConverter;
import middlegen.javax.JavaColumn;

/**
 * A decorated column used by the iBatis Plugin.
 *
 * @author David Channon
 * @author <a href="mailto:p.mouawad@ubik-ingenierie.com">Philippe Mouawad</a>
 * @created May 15, 2005
 */
public class IBatisColumn extends JavaColumn {
   /**
    * Constructs a new IBatisColumn, by decorating the provided column.
    *
    * @param column The column which will be decorated
    */
   public IBatisColumn(Column column) {
      super(column);
   }


   /**
    * Gets the Java name for this Column - i.e. the name of the java attribute associated with this column.
    *
    * @return The Java name as a String
    */
   public String getJavaName() {
      String columnName = DbNameConverter.getInstance().columnNameToVariableName(super.getSqlName());
      return columnName.substring(0, 1).toLowerCase() + columnName.substring(1);
   }
}
